Skip to content

docs: Update metrics docs to mention correct POWERTOOLS_METRICS_DISABLED variable name. #3848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Apr 23, 2025
Merged

docs: Update metrics docs to mention correct POWERTOOLS_METRICS_DISABLED variable name. #3848

merged 4 commits into from
Apr 23, 2025

Conversation

jorovipe97
Copy link
Contributor

@jorovipe97 jorovipe97 commented Apr 22, 2025 •
edited
Loading

Summary

Changes

Please provide a summary of what's being changed

The metrics docs mention POWERTOOLS_METRICS_ENABLED can be used to not log the metrics. However this env variable is not used. Insted it uses POWERTOOLS_METRICS_DISABLED.

Check line where env variables for Metrics are defined.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: #3847

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@jorovipe97
Docs: metrics.md file wrongly mentioned variable name to disable log
f81f02f 
Docs mentions POWERTOOLS_METRICS_ENABLED however the library does not uses this environment variable to control metrics logs. Instead it uses POWERTOOLS_METRICS_DISABLED
@jorovipe97
Docs: Update metrics.md in all parts where POWERTOOLS_METRICS_ENABLED…
41e5dc9 
… is mentioned
@jorovipe97
Update testingMetrics.ts example to use appropiate env variable name
c733298
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Apr 22, 2025
@boring-cyborg boring-cyborg
Copy link

boring-cyborg bot commented Apr 22, 2025

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Apr 22, 2025
@dreamorosi dreamorosi self-requested a review April 22, 2025 22:25
@github-actions GitHub Actions

This comment was marked as outdated.

Sign in to view
@github-actions github-actions bot added do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Apr 22, 2025
@dreamorosi dreamorosi removed do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Apr 22, 2025
dreamorosi
dreamorosi requested changes Apr 22, 2025
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please also update the env variable here?

Other than that it's ok.

@jorovipe97
docs: Update environment-variables.md
68495c5 
Update environment-variables.md file to mention `POWERTOOLS_METRICS_DISABLED` environment variable instead of `POWERTOOLS_METRICS_ENABLED`
@pull-request-size pull-request-size bot added size/S PR between 10-29 LOC and removed size/XS PR between 0-9 LOC labels Apr 23, 2025
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@jorovipe97
Copy link
Contributor Author

Hi @dreamorosi the change is ready, You can review again. Thanks!

@dreamorosi dreamorosi self-requested a review April 23, 2025 14:49
@dreamorosi dreamorosi merged commit 114188c into aws-powertools:main Apr 23, 2025
44 checks passed
@boring-cyborg boring-cyborg
Copy link

boring-cyborg bot commented Apr 23, 2025

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

@dreamorosi dreamorosi linked an issue Apr 23, 2025 that may be closed by this pull request
Docs: Metrics docs mention POWERTOOLS_METRICS_ENABLED however this variable is not used in code. #3847
Closed
1 task
@dreamorosi
Copy link
Contributor

Thank you for iterating on this PR and congrats on landing your first contribution in this project!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

@jorovipe97 jorovipe97

Labels
documentation Improvements or additions to documentation size/S PR between 10-29 LOC
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Metrics docs mention POWERTOOLS_METRICS_ENABLED however this variable is not used in code.
2 participants
@jorovipe97 @dreamorosi